/*
Copyright (c) 2008, Oleg S. Estekhin
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    * Neither the name of the copyright holders nor the names of its
      contributors may be used to endorse or promote products derived from this
      software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package ebml.viewer.tree;

import java.text.MessageFormat;

import javax.swing.Icon;
import javax.swing.tree.TreeNode;

/** The generic tree node. */
public final class FormatTreeNode extends ExtendedTreeNode {

    private MessageFormat messageFormat;

    private Object[] messageArguments;


    /**
     * Creates a new <code>FormatTreeNode</code> object.
     *
     * @param icon the icon or <code>null</code> if this node has no icon
     * @param messageFormat the message format
     * @param messageArguments the message arguments
     *
     * @throws NullPointerException if <code>messageFormat</code> if <code>null</code>
     */
    public FormatTreeNode(Icon icon, MessageFormat messageFormat, Object[] messageArguments) {
        this(null, null, icon, messageFormat, messageArguments);
    }

    /**
     * Creates a new <code>FormatTreeNode</code> object.
     *
     * @param parent the parent node or <code>null</code> if this node has no parent
     * @param children the children or <code>null</code> if this node does not allow children
     * @param icon the icon or <code>null</code> if this node has no icon
     * @param messageFormat the message format
     * @param messageArguments the message arguments
     *
     * @throws NullPointerException if <code>messageFormat</code> if <code>null</code>
     */
    public FormatTreeNode(TreeNode parent, TreeNode[] children, Icon icon, MessageFormat messageFormat, Object[] messageArguments) {
        super(parent, children, icon);
        if (messageFormat == null) {
            throw new NullPointerException("messageFormat is null");
        }
        this.messageFormat = messageFormat;
        this.messageArguments = messageArguments;
    }


    @Override
    public String getText() {
        return messageFormat.format(messageArguments, new StringBuffer(), null).toString();
    }


    /**
     * Returns the node message format.
     *
     * @return the node message format
     */
    public MessageFormat getMessageFormat() {
        return messageFormat;
    }

    /**
     * Changes the node message format
     *
     * @param messageFormat the new message format
     *
     * @throws NullPointerException if <code>messageFormat</code> if <code>null</code>
     */
    public void setMessageFormat(MessageFormat messageFormat) {
        if (messageFormat == null) {
            throw new NullPointerException("messageFormat is null");
        }
        this.messageFormat = messageFormat;
    }

    /**
     * Returns the message arguments.
     *
     * @return the message arguments or <code>null</code> if there are no message arguments
     */
    public Object[] getMessageArguments() {
        return messageArguments;
    }

    /**
     * Changes the message arguments.
     *
     * @param messageArguments the new message arguments
     */
    public void setMessageArguments(Object[] messageArguments) {
        this.messageArguments = messageArguments;
    }

}
